// --------------------------------------------------------------------------------------------------------------------
// <copyright file="DriveSensorStates.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
namespace Microsoft.Robotics.Hardware.EV4
{
    using System;

    /// <summary>
    /// Bit masks for drive controller binary sensors
    /// </summary>
    [Flags]
    public enum DriveSensorStates
    {
        /// <summary>
        /// State of AC adapter charging
        /// </summary>
        AcAdapterCharging = 0x0008, 

        /// <summary>
        /// State of left charging dock position sensor
        /// </summary>
        DockingSensorLeft = 0x0010, 

        /// <summary>
        /// State of right charging dock position sensor
        /// </summary>
        DockingSensorRight = 0x0020, 

        /// <summary>
        /// State of battery charging
        /// </summary>
        BatteryCharging = 0x0400, 

        /// <summary>
        /// State of the category 2 circuit.  When set a cliff sensor value
        /// exceeded the cliff detection threshold.
        /// </summary>
        Category2Triggered = 0x1000, 

        /// <summary>
        /// Identification bit of removable base unit ("shoes")
        /// </summary>
        ShoeId0 = 0x2000, 

        /// <summary>
        /// Identification bit of removable base unit ("shoes")
        /// </summary>
        ShoeId1 = 0x4000, 

        /// <summary>
        /// Identification bit of removable base unit ("shoes")
        /// </summary>
        ShoeId2 = 0x8000, 

        /// <summary>
        /// State of bump sensing detection
        /// </summary>
        BumpDetected = 0x00010000, 

        /// <summary>
        /// State of the dust filter
        /// </summary>
        DustFilterPresent = 0x00020000
    }
}
